Skip to content

API 文档

下班工具箱后端接口文档

API 文档

下班工具箱的后端基于 FastAPI 构建,提供本地 HTTP 接口供客户端调用。

基础信息

  • 服务地址:默认 http://127.0.0.1:7410(可在设置中修改)
  • 接口前缀:所有业务接口均以 /api/v1/ 开头
  • 数据格式:请求/响应均为 JSON(文件上传除外)

认证方式

后端通过 EDUASSIST_TOKEN 环境变量开启 Bearer Token 认证:

  • 所有接口(除 /healthOPTIONS 预检请求)都要求请求头携带 Authorization: Bearer <token>
  • 若未设置该环境变量(即 token 为空),则进入开发者模式,不做鉴权校验。
  • 未携带或携带错误的 token 时,返回 401,响应体为 {"detail": "Unauthorized"}

健康检查

  • GET /health:探测后端是否在线,返回 {"status": "ok"}

接口模块

模块说明
成绩相关成绩单制作、成绩分析
PDF 相关PDF 合并、拆分、压缩
津贴相关校历、假期修改、签到统计
认证用户注册
配置读取、更新配置

错误响应

业务校验失败时返回对应 HTTP 状态码,响应体结构统一为:

json
{ "detail": "错误信息" }

常见的错误码:

状态码含义
400请求参数不合法 / 业务校验失败
401未认证(token 缺失或错误)
404接口不存在
422请求体字段校验失败
500服务器内部错误

API 文档

下班工具箱的后端基于 FastAPI 构建,提供本地 HTTP 接口供客户端调用。

基础信息

  • 服务地址:默认 http://127.0.0.1:7410(可在设置中修改)
  • 接口前缀:所有业务接口均以 /api/v1/ 开头
  • 数据格式:请求/响应均为 JSON(文件上传除外)

认证方式

后端通过 EDUASSIST_TOKEN 环境变量开启 Bearer Token 认证:

  • 所有接口(除 /healthOPTIONS 预检请求)都要求请求头携带 Authorization: Bearer <token>
  • 若未设置该环境变量(即 token 为空),则进入开发者模式,不做鉴权校验。
  • 未携带或携带错误的 token 时,返回 401,响应体为 {"detail": "Unauthorized"}

健康检查

  • GET /health:探测后端是否在线,返回 {"status": "ok"}

接口模块

模块说明
成绩相关成绩单制作、成绩分析
PDF 相关PDF 合并、拆分、压缩
津贴相关校历、假期修改、签到统计
认证用户注册
配置读取、更新配置

错误响应

业务校验失败时返回对应 HTTP 状态码,响应体结构统一为:

json
{ "detail": "错误信息" }

常见的错误码:

状态码含义
400请求参数不合法 / 业务校验失败
401未认证(token 缺失或错误)
404接口不存在
422请求体字段校验失败
500服务器内部错误